/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package coalescent.cef.event;

import cef.event.Event;

import coalescent.phylogeny.CheckPPhylogenyAlgo;

import commons.core.ValueTypes;

/**
 * Provides input for the command {@link coalescent.cef.command.CheckPhylogenyCommand}.
 *
 * @author Susanta Tewari
 * @version 1.0 Dec 31, 2010
 */
public interface CheckPhylogenyEvent extends Event {

    /**
     * This algorithm can test if a given binary data (see {@link #getData() getData()}) is a
     * phylogeny.
     *
     * @return an algorithm to test phylogeny
     */
    CheckPPhylogenyAlgo getPhylogenyAlgorithm();

    /**
     * The arrays in data are of the same length and contain only values 0 and 1.
     *
     * @return binary data for testing phylogeny
     */
    ValueTypes.ByteArrayList getData();
}
